<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>vprocss: periph.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">vprocss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('periph_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">periph.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is top level resource file that will initialize all system level peripherals. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
1.00  rc   07/07/14   First release
2.00  dmc  12/02/15   Removed UART driver instance
           01/25/16   Remove inclusion xdebug.h and use of xdbg_printf()
           01/25/16   Support a new GPIO instance to reset IP inside the VPSS
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Reset Network</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The following constants define various reset lines in the subsystem </p>
</div></td></tr>
<tr class="memitem:a350691590a5a33769f9b4ccaaf67515f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a350691590a5a33769f9b4ccaaf67515f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>XPER_HLSIP_RESET</b>&#160;&#160;&#160;(0x00)</td></tr>
<tr class="separator:a350691590a5a33769f9b4ccaaf67515f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a743e35812efd2832bf367b735edf9db1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a743e35812efd2832bf367b735edf9db1"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>XPER_HLSIP_ENABLE</b>&#160;&#160;&#160;(0x01)</td></tr>
<tr class="separator:a743e35812efd2832bf367b735edf9db1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a031f74192dd2f5bc81a370043141d63d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="periph_8c.html#a031f74192dd2f5bc81a370043141d63d">XPeriph_ReportDeviceInfo</a> (<a class="el" href="struct_x_periph.html">XPeriph</a> *InstancePtr)</td></tr>
<tr class="memdesc:a031f74192dd2f5bc81a370043141d63d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reports system wide common peripherals included in the design.  <a href="#a031f74192dd2f5bc81a370043141d63d">More...</a><br/></td></tr>
<tr class="separator:a031f74192dd2f5bc81a370043141d63d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf9db5b3ae03d0367de50a8cf1926421"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="periph_8c.html#acf9db5b3ae03d0367de50a8cf1926421">XPeriph_PowerOnInit</a> (<a class="el" href="struct_x_periph.html">XPeriph</a> *InstancePtr)</td></tr>
<tr class="memdesc:acf9db5b3ae03d0367de50a8cf1926421"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes system wide common peripherals.  <a href="#acf9db5b3ae03d0367de50a8cf1926421">More...</a><br/></td></tr>
<tr class="separator:acf9db5b3ae03d0367de50a8cf1926421"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a290ba39007d2e8b190d999e38c9dcc77"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="periph_8c.html#a290ba39007d2e8b190d999e38c9dcc77">XPeriph_ResetHlsIp</a> (<a class="el" href="struct_x_periph.html">XPeriph</a> *InstancePtr)</td></tr>
<tr class="memdesc:a290ba39007d2e8b190d999e38c9dcc77"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets the Hls IP block(s)  <a href="#a290ba39007d2e8b190d999e38c9dcc77">More...</a><br/></td></tr>
<tr class="separator:a290ba39007d2e8b190d999e38c9dcc77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a4e8fe358f8a861cba5c75b7f9ac81b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="periph_8c.html#a3a4e8fe358f8a861cba5c75b7f9ac81b">XPeriph_ConfigTpg</a> (<a class="el" href="struct_x_periph.html">XPeriph</a> *InstancePtr)</td></tr>
<tr class="memdesc:a3a4e8fe358f8a861cba5c75b7f9ac81b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures TPG to user defined parameters.  <a href="#a3a4e8fe358f8a861cba5c75b7f9ac81b">More...</a><br/></td></tr>
<tr class="separator:a3a4e8fe358f8a861cba5c75b7f9ac81b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cf2c45686f66190edb39203838e3f61"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="periph_8c.html#a5cf2c45686f66190edb39203838e3f61">XPeriph_SetTpgParams</a> (<a class="el" href="struct_x_periph.html">XPeriph</a> *InstancePtr, u16 width, u16 height, XVidC_ColorFormat Cformat, u16 Pattern, u16 IsInterlaced)</td></tr>
<tr class="memdesc:a5cf2c45686f66190edb39203838e3f61"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function programs TPG to user defined resolution.  <a href="#a5cf2c45686f66190edb39203838e3f61">More...</a><br/></td></tr>
<tr class="separator:a5cf2c45686f66190edb39203838e3f61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05f04ab9a977fc436a0713f64656f623"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="periph_8c.html#a05f04ab9a977fc436a0713f64656f623">XPeriph_DisableTpg</a> (<a class="el" href="struct_x_periph.html">XPeriph</a> *InstancePtr)</td></tr>
<tr class="memdesc:a05f04ab9a977fc436a0713f64656f623"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function stops TPG IP.  <a href="#a05f04ab9a977fc436a0713f64656f623">More...</a><br/></td></tr>
<tr class="separator:a05f04ab9a977fc436a0713f64656f623"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a962fee15afc28a586c9608d96b302590"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="periph_8c.html#a962fee15afc28a586c9608d96b302590">XPeriph_TpgDbgReportStatus</a> (<a class="el" href="struct_x_periph.html">XPeriph</a> *InstancePtr)</td></tr>
<tr class="memdesc:a962fee15afc28a586c9608d96b302590"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reports TPG Status.  <a href="#a962fee15afc28a586c9608d96b302590">More...</a><br/></td></tr>
<tr class="separator:a962fee15afc28a586c9608d96b302590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45b699020b950515ee1756c865fc1810"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="periph_8c.html#a45b699020b950515ee1756c865fc1810">XPeriph_ConfigVtc</a> (<a class="el" href="struct_x_periph.html">XPeriph</a> *InstancePtr, XVidC_VideoStream *StreamPtr, u32 PixPerClk)</td></tr>
<tr class="memdesc:a45b699020b950515ee1756c865fc1810"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures VTC to output parameters.  <a href="#a45b699020b950515ee1756c865fc1810">More...</a><br/></td></tr>
<tr class="separator:a45b699020b950515ee1756c865fc1810"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a3a4e8fe358f8a861cba5c75b7f9ac81b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPeriph_ConfigTpg </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_periph.html">XPeriph</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures TPG to user defined parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the peripheral instance </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a45b699020b950515ee1756c865fc1810"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPeriph_ConfigVtc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_periph.html">XPeriph</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_VideoStream *&#160;</td>
          <td class="paramname"><em>StreamPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>PixPerClk</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures VTC to output parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the peripheral instance </td></tr>
    <tr><td class="paramname">StreamPtr</td><td>is a pointer output stream </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a05f04ab9a977fc436a0713f64656f623"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPeriph_DisableTpg </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_periph.html">XPeriph</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function stops TPG IP. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the peripheral instance </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="acf9db5b3ae03d0367de50a8cf1926421"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPeriph_PowerOnInit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_periph.html">XPeriph</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes system wide common peripherals. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS </dd></dl>

<p>References <a class="el" href="periph_8c.html#a290ba39007d2e8b190d999e38c9dcc77">XPeriph_ResetHlsIp()</a>.</p>

<p>Referenced by <a class="el" href="system_8h.html#adc710a6298515ea6e63a39567010bc75">XSys_Init()</a>.</p>

</div>
</div>
<a class="anchor" id="a031f74192dd2f5bc81a370043141d63d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPeriph_ReportDeviceInfo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_periph.html">XPeriph</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reports system wide common peripherals included in the design. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="system_8h.html#a782ef0a1a4d351df9c125446c81dd1be">XSys_ReportSystemInfo()</a>.</p>

</div>
</div>
<a class="anchor" id="a290ba39007d2e8b190d999e38c9dcc77"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPeriph_ResetHlsIp </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_periph.html">XPeriph</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function resets the Hls IP block(s) </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the peripheral instance </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="periph_8h.html#acf9db5b3ae03d0367de50a8cf1926421">XPeriph_PowerOnInit()</a>.</p>

</div>
</div>
<a class="anchor" id="a5cf2c45686f66190edb39203838e3f61"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPeriph_SetTpgParams </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_periph.html">XPeriph</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>height</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorFormat&#160;</td>
          <td class="paramname"><em>Cformat</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Pattern</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>IsInterlaced</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function programs TPG to user defined resolution. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the peripheral instance </td></tr>
    <tr><td class="paramname">width</td><td>is the new active width </td></tr>
    <tr><td class="paramname">height</td><td>is the new active height </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="periph_8h.html#a34f5e8498f67c2e6a4617db0fe9cf03e">XPeriph_SetTPGColorFormat</a>, <a class="el" href="periph_8h.html#aba163fdeefb67d6216557f6d42e5cf79">XPeriph_SetTPGHeight</a>, <a class="el" href="periph_8h.html#a8bdf3c6780c5bddd8a20f936f6f88354">XPeriph_SetTPGInterlacedMode</a>, <a class="el" href="periph_8h.html#ad604967e823512d326a40915d871894a">XPeriph_SetTPGPattern</a>, and <a class="el" href="periph_8h.html#a36c3d24ba0ff02c1dc9e63ec9a770206">XPeriph_SetTPGWidth</a>.</p>

</div>
</div>
<a class="anchor" id="a962fee15afc28a586c9608d96b302590"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPeriph_TpgDbgReportStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_periph.html">XPeriph</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reports TPG Status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the peripheral instance </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
